Skip to main content

Jira Connector

The Jira system connector in SyncNow allows users to synchronize, enrich, and link issues from Jira Cloud with other work systems. SyncNow can automatically register Jira webhooks for continuous synchronization. SyncNow connector can work with Jira Data Center or Jira Cloud.

SyncNow can auto register Jira webhooks for continuous synchronization.

Key Features of the Jira Connector

  • Entity Synchronization: Synchronize issues such as epics, stories, and bugs from Jira to other work systems and vice versa.
  • Field Synchronization: Synchronize comments, rich text fields (WIKI), links, select lists, statuses of sprints, releases, users, and attachments.
  • Enrichment and Linking: Enrich, link, and add comments to every Jira entity.

Setting Up the Jira Connector

To set up the Jira connector in SyncNow, follow these steps:

  1. Navigate to the Systems Page

    • Access the "Systems" page from the main menu.
  2. Add a New System

    • Press the "Add System" button to create a new system connector.
  3. Configure the Jira Cloud Connector

    • Name: Enter a unique name for the Jira Cloud connector.
    • Type: Select “Jira Software Cloud” from the "Type" dropdown menu.
    • Allow Self-Signed Certificates: Enable or disable the toggle for self-signed certificates.
    • URL: Provide the URL to the Jira instance.
    • Username and Access Token: Enter the username and access token for the Jira instance. (Create an API token if not already done.)
    • API Version (Optional): Add a preferred Jira API version. Currently, SyncNow supports only API v2.
    • Webhook Security: Configure system connector security options used for webhooks in SyncNow.
  4. Verify and Save

    • Press the "Verify Connection" button to check if the connection is established successfully.
    • Press the "Save" button to save the connector settings.

Limitations

  • Field Changes for Timer Synchronization: In the default timer synchronization configuration, field changes are required to detect relationship changes. Jira does not notify SyncNow when only relations (like issue links) are added or removed. Sync processes subscribed to WebHooks will handle these changes as expected.
  • Entity Type Changes: Changing the type of an entity is not supported.
  • Project Moves: Moving an entity to another project is not supported.
  • Rich Text Fields and Attachments: SyncNow supports synchronization of rich text fields and attachments, but embedded attachments within rich text fields are not supported.

Major Supported Fields

Field NameField TypeSync Direction
SummaryTextBidirectional
DescriptionRich Text (WIKI)Bidirectional
Issue TypeSelect ListUnidirectional (Jira to Other Systems)
StatusSelect ListBidirectional
PrioritySelect ListBidirectional
LabelsMulti-Select ListBidirectional
AssigneeUserBidirectional
ReporterUserBidirectional
CommentsRich Text (WIKI)Bidirectional
AttachmentsFileBidirectional
Due DateDateBidirectional
Created DateDateUnidirectional (Jira to Other Systems)
Updated DateDateUnidirectional (Jira to Other Systems)
Fix VersionSelect ListBidirectional
ComponentsMulti-Select ListBidirectional
Custom FieldsVarious (Text, Number, Date, etc.)Bidirectional
SprintsSelect ListBidirectional
EpicLinkBidirectional
Sub-TasksLinkBidirectional
Story PointsNumberBidirectional
ResolutionSelect ListBidirectional
EnvironmentTextBidirectional
Original EstimateTime TrackingBidirectional
Remaining EstimateTime TrackingBidirectional
Time SpentTime TrackingBidirectional
  • Embedded Attachments: SyncNow fully supports attachments and rich text fields with pictures. However, synchronization might have limitations depending on the target system's capabilities.

Jira - Xray Extension

SyncNow operators can use our predefined template with XRAY extension to synchronize requirements, tests, defects to and from Jira Xray.

SyncNow Xray extension has the ability to sync tests with with test steps and attachments.